Resource URL: /platform/<<version=1>>/auth/groups/<GROUP>

    Overview: This resource applies the standard collection pattern to
              individual groups.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve the group information.

       URL: GET /platform/<<version=1>>/auth/groups/<GROUP>

Query arguments:
         cached=<boolean> If true, only return cached objects.
query_member_of=<boolean> Enumerate all groups that a group is a member of.
  resolve_names=<boolean> Resolve names of personas.
            zone=<string> Filter groups by zone.
        provider=<string> Filter groups by provider.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "groups": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies configuration properties for a group.", 
            "properties": {
              "dn": {
                "required": true, 
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies the distinguished name for the user."
              }, 
              "domain": {
                "required": true, 
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies the domain that the object is part of."
              }, 
              "generated_gid": {
                "required": true, 
                "type": [
                  "boolean", 
                  "null"
                ], 
                "description": "If true, the GID was generated."
              }, 
              "name": {
                "minLength": 0, 
                "required": true, 
                "type": "string", 
                "description": "Specifies a user or group name.", 
                "maxLength": 255
              }, 
              "member_of": {
                "required": true, 
                "type": [
                  {
                    "type": "null"
                  }, 
                  {
                    "minItems": 0, 
                    "items": {
                      "type": "object", 
                      "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                      "properties": {
                        "type": {
                          "enum": [
                            "user", 
                            "group", 
                            "wellknown"
                          ], 
                          "type": "string", 
                          "description": "Specifies the type of persona, which must be combined with a name."
                        }, 
                        "id": {
                          "minLength": 0, 
                          "type": "string", 
                          "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                          "maxLength": 261
                        }, 
                        "name": {
                          "minLength": 0, 
                          "type": "string", 
                          "description": "Specifies the persona name, which must be combined with a type.", 
                          "maxLength": 255
                        }
                      }
                    }, 
                    "type": "array", 
                    "maxItems": 4294967295
                  }
                ], 
                "description": "Specifies the groups that this user or group are members of."
              }, 
              "sid": {
                "required": true, 
                "type": [
                  {
                    "type": "object", 
                    "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                    "properties": {
                      "type": {
                        "enum": [
                          "user", 
                          "group", 
                          "wellknown"
                        ], 
                        "type": "string", 
                        "description": "Specifies the type of persona, which must be combined with a name."
                      }, 
                      "id": {
                        "minLength": 0, 
                        "type": "string", 
                        "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                        "maxLength": 261
                      }, 
                      "name": {
                        "minLength": 0, 
                        "type": "string", 
                        "description": "Specifies the persona name, which must be combined with a type.", 
                        "maxLength": 255
                      }
                    }
                  }
                ], 
                "description": "Specifies the security identifier."
              }, 
              "dns_domain": {
                "required": true, 
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies the DNS domain."
              }, 
              "sam_account_name": {
                "required": true, 
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies a user or group name."
              }, 
              "gid": {
                "required": true, 
                "type": [
                  {
                    "type": "object", 
                    "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                    "properties": {
                      "type": {
                        "enum": [
                          "user", 
                          "group", 
                          "wellknown"
                        ], 
                        "type": "string", 
                        "description": "Specifies the type of persona, which must be combined with a name."
                      }, 
                      "id": {
                        "minLength": 0, 
                        "type": "string", 
                        "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                        "maxLength": 261
                      }, 
                      "name": {
                        "minLength": 0, 
                        "type": "string", 
                        "description": "Specifies the persona name, which must be combined with a type.", 
                        "maxLength": 255
                      }
                    }
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies the numeric group identifier."
              }, 
              "object_history": {
                "type": [
                  {
                    "type": "null"
                  }, 
                  {
                    "minItems": 0, 
                    "items": {
                      "type": "object", 
                      "properties": {
                        "gid": {
                          "type": [
                            {
                              "type": "object", 
                              "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                              "properties": {
                                "type": {
                                  "enum": [
                                    "user", 
                                    "group", 
                                    "wellknown"
                                  ], 
                                  "type": "string", 
                                  "description": "Specifies the type of persona, which must be combined with a name."
                                }, 
                                "id": {
                                  "minLength": 0, 
                                  "type": "string", 
                                  "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                                  "maxLength": 261
                                }, 
                                "name": {
                                  "minLength": 0, 
                                  "type": "string", 
                                  "description": "Specifies the persona name, which must be combined with a type.", 
                                  "maxLength": 255
                                }
                              }
                            }, 
                            "null"
                          ]
                        }, 
                        "uid": {
                          "type": [
                            {
                              "type": "object", 
                              "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                              "properties": {
                                "type": {
                                  "enum": [
                                    "user", 
                                    "group", 
                                    "wellknown"
                                  ], 
                                  "type": "string", 
                                  "description": "Specifies the type of persona, which must be combined with a name."
                                }, 
                                "id": {
                                  "minLength": 0, 
                                  "type": "string", 
                                  "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                                  "maxLength": 261
                                }, 
                                "name": {
                                  "minLength": 0, 
                                  "type": "string", 
                                  "description": "Specifies the persona name, which must be combined with a type.", 
                                  "maxLength": 255
                                }
                              }
                            }, 
                            "null"
                          ]
                        }, 
                        "sid": {
                          "type": "object", 
                          "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                          "properties": {
                            "type": {
                              "enum": [
                                "user", 
                                "group", 
                                "wellknown"
                              ], 
                              "type": "string", 
                              "description": "Specifies the type of persona, which must be combined with a name."
                            }, 
                            "id": {
                              "minLength": 0, 
                              "type": "string", 
                              "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                              "maxLength": 261
                            }, 
                            "name": {
                              "minLength": 0, 
                              "type": "string", 
                              "description": "Specifies the persona name, which must be combined with a type.", 
                              "maxLength": 255
                            }
                          }
                        }
                      }
                    }, 
                    "type": "array", 
                    "maxItems": 4294967295
                  }
                ]
              }, 
              "provider": {
                "required": true, 
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies the authentication provider that the object belongs to."
              }, 
              "type": {
                "minLength": 0, 
                "required": true, 
                "type": "string", 
                "description": "Specifies the object type.", 
                "maxLength": 255
              }, 
              "id": {
                "minLength": 0, 
                "required": true, 
                "type": "string", 
                "description": "Specifies the user or group ID.", 
                "maxLength": 255
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify the group.

       URL: PUT /platform/<<version=1>>/auth/groups/<GROUP>

Query arguments:
  force=<boolean> Changes to the group ID can result in loss of access to the
                  file system. To mitigate this risk of lost access, the force
                  option is required for group ID changes.
    zone=<string> Optional zone.
provider=<string> Optional provider type.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies the configuration properties for a group.", 
  "properties": {
    "gid": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Specifies the numeric group identifier.", 
      "maximum": 4294967295
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete the group.

          URL: DELETE /platform/<<version=1>>/auth/groups/<GROUP>

Query arguments:
 cached=<boolean> If true, flush the group from the cache.
    zone=<string> Filter groups by zone.
provider=<string> Filter groups by provider.

There is no JSON response body for this method.
